<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class PhpThumb</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> PhpThumb</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">PhpThumb Object</p>
<p class="description"><p>This singleton object is essentially a function library that helps with core validation  and loading of the core classes and plugins.  There isn't really any need to access it directly,  unless you're developing a plugin and need to take advantage of any of the functionality contained  within.</p><p>If you're not familiar with singleton patterns, here's how you get an instance of this class (since you  can't create one via the new keyword):  <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$pt&nbsp;</span>=&nbsp;<span class="src-id"><a href="../../PhpThumb/Core/PhpThumb.html">PhpThumb</a></span><span class="src-sym">::</span><a href="../../PhpThumb/Core/PhpThumb.html#methodgetInstance">getInstance</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p>It's that simple!  Outside of that, there's no need to modify anything within this class, unless you're doing  some crazy customization... then knock yourself out! :)</p></p>
	<ul class="tags">
				<li><span class="field">usedby:</span> <a href="../../PhpThumb/Core/PhpThumbFactory.html#methodcreate">PhpThumbFactory::create()</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_clientResources---php---others---phpThumb---PhpThumb.inc.php.html">/clientResources/php/others/phpThumb/PhpThumb.inc.php</a> (line <span class="field">45</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																				<div class="var-title">
					<img src="../../media/images/StaticVariable.png" alt=" " />
					static <span class="var-type"><a href="../../PhpThumb/Core/PhpThumb.html">object PhpThumb</a></span>
					<a href="#$_instance" title="details" class="var-name">$_instance</a>
				</div>
																												<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">array</span>
					<a href="#$_implementations" title="details" class="var-name">$_implementations</a>
				</div>
																								<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">array</span>
					<a href="#$_registry" title="details" class="var-name">$_registry</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												<div class="method-definition">
					<img src="../../media/images/StaticMethod.png" alt=" "/>
											static <span class="method-result"><a href="../../PhpThumb/Core/PhpThumb.html">PhpThumb</a></span>
										<a href="#getInstance" title="details" class="method-name">getInstance</a>
										()
									</div>
																																																												<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">array</span>
										<a href="#getPluginRegistry" title="details" class="method-name">getPluginRegistry</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$implementation</span>)
									</div>
																<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#isValidImplementation" title="details" class="method-name">isValidImplementation</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$implementation</span>)
									</div>
																<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#loadPlugins" title="details" class="method-name">loadPlugins</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$pluginPath</span>)
									</div>
																<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#registerPlugin" title="details" class="method-name">registerPlugin</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$pluginName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$implementation</span>)
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$_instance" id="$_instance"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			static <span class="var-type"><a href="../../PhpThumb/Core/PhpThumb.html">object PhpThumb</a></span>
			<span class="var-name">$_instance</span>
						(line <span class="line-number">52</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Instance of self</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>

<a name="var$_implementations" id="$_implementations"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$_implementations</span>
						(line <span class="line-number">72</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">What implementations are available</p>
<p class="description"><p>This stores what implementations are available based on the loaded  extensions in PHP, NOT whether or not the class files are present.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$_registry" id="$_registry"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$_registry</span>
						(line <span class="line-number">63</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The plugin registry</p>
<p class="description"><p>This is where all plugins to be loaded are stored.  Data about the plugin is  provided, and currently consists of: <ul><li>loaded: true/false</li><li>implementation: gd/imagick/both</li></ul></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetInstance" id="getInstance"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/StaticMethod.png" />
		<span class="method-title">static getInstance</span> (line <span class="line-number">81</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an instance of self</p>
<p class="description"><p>This is the usual singleton function that returns / instantiates the object</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../../PhpThumb/Core/PhpThumb.html">PhpThumb</a></span>
		<span class="method-name">
			getInstance
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetPluginRegistry" id="getPluginRegistry"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">getPluginRegistry</span> (line <span class="line-number">233</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the plugin registry for the supplied implementation</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getPluginRegistry
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$implementation</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$implementation</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisValidImplementation" id="isValidImplementation"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">isValidImplementation</span> (line <span class="line-number">140</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns whether or not $implementation is valid (available)</p>
<p class="description"><p>If 'all' is passed, true is only returned if ALL implementations are available.</p><p>You can also pass 'n/a', which always returns true</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			isValidImplementation
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$implementation</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$implementation</span>			</li>
				</ul>
		
			
	</div>
<a name="methodloadPlugins" id="loadPlugins"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">loadPlugins</span> (line <span class="line-number">205</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads all the plugins in $pluginPath</p>
<p class="description"><p>All this function does is include all files inside the $pluginPath directory.  The plugins themselves  will not be added to the registry unless you've properly added the code to do so inside your plugin file.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			loadPlugins
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pluginPath</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pluginPath</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterPlugin" id="registerPlugin"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">registerPlugin</span> (line <span class="line-number">186</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Registers a plugin in the registry</p>
<p class="description"><p>Adds a plugin to the registry if it isn't already loaded, and if the provided  implementation is valid.  Note that you can pass the following special keywords  for implementation: <ul><li>all - Requires that all implementations be available</li><li>n/a - Doesn't require any implementation</li></ul>  When a plugin is added to the registry, it's added as a key on $this-&gt;_registry with the value  being an array containing the following keys: <ul><li>loaded - whether or not the plugin has been &quot;loaded&quot; into the core class</li><li>implementation - what implementation this plugin is valid for</li></ul></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			registerPlugin
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pluginName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$implementation</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pluginName</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$implementation</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Fri, 22 Feb 2013 05:33:59 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>